Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget.custom/CustomMultilineTextWidget

CustomMultilineTextWidget

class CustomMultilineTextWidget @JvmOverloads constructor(message: Text, lineHeight: Int = 9, topPadding: Int = 0, bottomPadding: Int = topPadding, leftPadding: Int = 0, rightPadding: Int = 0) : CustomTextWidget

Multiline text widget that aligns its text to the left and has a resizable width.

Author

fzzyhmstrs

Since

0.6.0, left and right padding 0.6.5, handles click and hover events 0.7.0

Parameters

message

Text the text to split and display

lineHeight

space between lines, default 9 (MC standard)

topPadding

pixels of padding above the text. Will add to the widget's height.

bottomPadding

pixels of padding below the text. Will add to the widget's height.

leftPadding

pixels of padding on the left side of the text.

rightPadding

pixels of padding on the right side of the text.

Constructors

CustomMultilineTextWidget

@JvmOverloads

constructor(message: Text, lineHeight: Int = 9, topPadding: Int = 0, bottomPadding: Int = topPadding, leftPadding: Int = 0, rightPadding: Int = 0)

Types

MultilineText

interface MultilineText

Properties

active

var active: Boolean

focused

var focused: Boolean

navigationOrder

var navigationOrder: Int

visible

var visible: Boolean

var x: Int

var y: Int

Functions

alignRight

fun alignRight(): CustomMultilineTextWidget

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

draw

open override fun draw(textConsumer: DrawnTextConsumer)

forEachChild

open override fun forEachChild(consumer: Consumer<ClickableWidget>)

getAlpha

open fun getAlpha(): Float

getBorder

open fun getBorder(direction: NavigationDirection): ScreenRect

getBottom

open fun getBottom(): Int

getFocusedPath

open fun getFocusedPath(): @Nullable GuiNavigationPath

getHeight

open override fun getHeight(): Int

getMessage

open fun getMessage(): Text

getNarratedParts

open fun getNarratedParts(): MutableCollection<out Selectable>

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

open override fun getNavigationPath(navigation: GuiNavigation): @Nullable GuiNavigationPath

getRight

open fun getRight(): Int

getType

open override fun getType(): Selectable.SelectionType

getWidth

open override fun getWidth(): Int

isClickable

open fun isClickable(): Boolean

isHovered

open fun isHovered(): Boolean

isInteractable

open override fun isInteractable(): Boolean

isMouse

open fun isMouse(event: CustomWidget.MouseEvent): Boolean

isMouseOver

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

isSelected

open fun isSelected(): Boolean

maxWidthNeeded

fun maxWidthNeeded(): Int

mouseMoved

open fun mouseMoved(mouseX: Double, mouseY: Double)

onChar

open fun onChar(event: CustomWidget.CharEvent): Boolean

Handles char input events for custom widgets. Override this for handling keyboard inputs.

onClick

open fun onClick(clickedStyleConsumer: @Nullable Consumer<Style>): AbstractTextWidget

onKey

open override fun onKey(event: CustomWidget.KeyEvent): Boolean

Handles keyboard events for custom widgets. Override this for handling keyboard inputs.

onKeyRelease

open fun onKeyRelease(event: CustomWidget.KeyEvent): Boolean

Handles keyboard release events for custom widgets. Override this for handling keyboard inputs.

onMouse

open override fun onMouse(event: CustomWidget.MouseEvent): Boolean

Handles mouse click events for custom widgets. Override this or onPress for handling mouse inputs.

onMouseDrag

open fun onMouseDrag(event: CustomWidget.MouseEvent): Boolean

Handles mouse drag events for custom widgets. Override this for handling drag inputs

onMouseRelease

open fun onMouseRelease(event: CustomWidget.MouseEvent): Boolean

Handles mouse button release events for custom widgets. Override this for handling mouse inputs.

onMouseScroll

open fun onMouseScroll(event: CustomWidget.MouseEvent): Boolean

Handles mouse scroll events for custom widgets. Override this for handling mouse inputs.

onPress

open override fun onPress(event: CustomWidget.MouseEvent): Boolean

playDownSound

open fun playDownSound(soundManager: SoundManager)

render

override fun render(context: DrawContext, mouseX: Int, mouseY: Int, deltaTicks: Float)

renderCustom

open fun renderCustom(context: DrawContext, mouseX: Int, mouseY: Int, deltaTicks: Float)

renderWidget

override fun renderWidget(context: DrawContext, mouseX: Int, mouseY: Int, deltaTicks: Float)

setAlpha

open fun setAlpha(alpha: Float)

setDimensions

open fun setDimensions(width: Int, height: Int)

setDimensionsAndPosition

open fun setDimensionsAndPosition(width: Int, height: Int, x: Int, y: Int)

setHeight

open override fun setHeight(height: Int)

setMessage

open override fun setMessage(message: Text)

setPosition

open fun setPosition(x: Int, y: Int)

setTooltip

open fun setTooltip(tooltip: @Nullable Tooltip)

setTooltipDelay

open fun setTooltipDelay(tooltipDelay: Duration)

setWidth

open fun setWidth(width: Int)